<!doctype html>
<html>
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width">
        <meta name="restype" content="api">
        <meta name="product" content="kendo-ui">
        
        <title>API Reference for Kendo Data SchedulerEvent</title>
        <link rel="shortcut icon" href="/favicon.ico"/>
        <meta name="description" content="Documentation how to get started with the SchedulerEvent.">
        <link href="//fonts.googleapis.com/css?family=Roboto:400,500,700,900" rel="stylesheet">
        <link href='https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700' rel='stylesheet' type='text/css'>
        <!-- <link href="https://kendo.cdn.telerik.com/2017.3.1026/styles/kendo.common.min.css" rel="stylesheet" /> -->
        <link rel="stylesheet" href="http://oygy5legq.bkt.clouddn.com/kendo.common.min.css">
        <link rel="stylesheet" href="/assets/styles.css?cb=8338967476da1c756a6defe19c1f9984">
        <link rel="stylesheet" href="/assets/icon-font.css?cb=25d8b9593057297c278fcd6d7d263c8e">
        <link rel="stylesheet" href="/assets/theme.css?cb=d82da02940126146560da1ae3bb0bf64">
        
        <!-- <script src="https://code.jquery.com/jquery-1.10.2.js"></script> -->
        <script src="https://cdn.bootcss.com/jquery/1.10.2/jquery.min.js"></script>
        <!-- <script src="https://kendo.cdn.telerik.com/2017.3.1026/js/kendo.web.min.js"></script> -->
        <script src="http://oygy5legq.bkt.clouddn.com/kendo.web.min.js"></script>
        <!-- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.6.0/codemirror.min.css">
        <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.6.0/codemirror.min.js"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.6.0/mode/javascript/javascript.min.js"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.6.0/mode/css/css.min.js"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.6.0/mode/xml/xml.min.js"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.6.0/mode/htmlmixed/htmlmixed.min.js"></script> -->
        <script src="/assets/prettify.js?cb=9671553084e1962263b152af1f563c3c"></script>
        <script src="/assets/app.js?cb=c577f29da14c3752a8c4ba001dde39e5"></script>
        
        <script src="/assets/dojo.js?cb=545f7f252dd3279c5a236b777c1668f1"></script>
        
        

        <!--[if lt IE 9]>
        <script>
        document.createElement('header');
        document.createElement('nav');
        document.createElement('section');
        document.createElement('article');
        document.createElement('aside');
        document.createElement('footer');
        document.createElement('hgroup');
        </script>
        <![endif]-->
    </head>
    <body>
        <!-- Google Tag Manager -->
        <!-- <noscript>
            <iframe src="//www.googletagmanager.com/ns.html?id=GTM-6X92" height="0" width="0" style="display: none; visibility: hidden"></iframe>
        </noscript>
        <script>(function(w, d, s, l, i) { w[l] = w[l] || []; w[l].push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' }); var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src = '//www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f); })(window, document, 'script', 'dataLayer', 'GTM-6X92');</script> -->
        <!-- End Google Tag Manager -->
        <aside class="TK-Hat">
    <figure class="TK-Hat-Brand">
        <a href="https://www.progress.com" class="TK-PRGS-Logo">
            <svg xmlns="http://www.w3.org/2000/svg" width="94" height="40" viewBox="0 0 512 120">
                <path fill="#5ce500" d="M95.52 29.33v51a3.93 3.93 0 0 1-1.78 3.08l-1.67 1-12.72 7.35-8.59 5-1.78 1V42.6L21.23 15 43.91 1.93 46 .74a3.94 3.94 0 0 1 3.56 0L81 18.9l14.51 8.38v2.05zM58.36 48.72l-9.79-5.66-22.91-13.23a4 4 0 0 0-3.56 0L1.77 41.57 0 42.6l34.49 19.91v39.83l20.3-11.73 1.79-1a3.94 3.94 0 0 0 1.78-3.08V48.72zM0 82.43l23.86 13.78V68.63z"></path>
                <path fill="#4b4e52" d="M148.09 27.28h-26v70.48h11.55V70.1h14.57c15.77 0 24.45-7.7 24.45-21.69 0-6.35-2.4-21.12-24.55-21.12m12.78 21.31c0 7.95-4.12 11.19-14.24 11.19h-13v-22.1h14.57c8.56 0 12.71 3.57 12.71 10.91M207 46.41l.87.42-2 10.42-1.35-.42a11.32 11.32 0 0 0-3.34-.51c-10.79 0-11.67 8.59-11.67 19v22.44h-10.64V46h10v6.24c2.73-4.2 6-6.37 10.37-6.9a14.55 14.55 0 0 1 7.76 1.07M233.29 45c-8.42 0-15.16 3.2-19.5 9.27-4.56 6.37-5.23 13.85-5.23 17.74 0 16.36 9.7 26.92 24.73 26.92 18.26 0 24.73-14.71 24.73-27.3 0-7.25-2.15-13.82-6-18.51-4.41-5.31-10.87-8.12-18.7-8.12m0 44.38c-8.37 0-13.57-6.66-13.57-17.37s5.2-17.55 13.57-17.55S247 61.23 247 71.78c0 10.83-5.24 17.56-13.66 17.56m114.55-42.93l.87.42-2 10.42-1.35-.42a11.26 11.26 0 0 0-3.33-.51c-10.78 0-11.66 8.59-11.66 19v22.44h-10.66V46h10v6.24c2.73-4.2 6-6.37 10.37-6.9a14.54 14.54 0 0 1 7.73 1.06m38.4 34.76l-.2.57c-2.23 6.36-7.57 7.7-11.65 7.7-8.09 0-13.3-5.37-13.81-14.09h36.59l.13-1a31.26 31.26 0 0 0 .12-4.12v-.93C396.93 54.78 387.48 45 374 45c-7.9 0-14.37 3.1-18.73 9a30.85 30.85 0 0 0-5.54 18c0 16 9.95 26.74 24.74 26.74 11.45 0 19.33-5.82 22.2-16.38l.33-1.2h-10.7zM361 66.05c.9-7.17 5.81-11.73 12.79-11.73 5.33 0 11.64 3.1 12.52 11.73H361zm-60.7-15.71c-3.45-3.58-8.06-5.39-13.76-5.39-15.69 0-22.83 13.81-22.83 26.63 0 13.16 7.06 26.44 22.83 26.44a18.33 18.33 0 0 0 13.35-5.42c0 2.28-.1 4.45-.16 5.38-.58 8.54-4.68 12.51-12.91 12.51-4.47 0-9.61-1.59-10.6-6l-.22-1h-10.54l.17 1.41c1.1 9.12 9.11 14.79 20.9 14.79 10.34 0 17.7-3.9 21.28-11.26 1.73-3.55 2.6-8.72 2.6-15.37V46h-10.13v4.34zm-13.11 38.15c-3.74 0-12.43-1.69-12.43-17.37 0-10.3 4.87-16.7 12.71-16.7 6.06 0 12.52 4.39 12.52 16.7 0 10.87-4.79 17.37-12.81 17.37m159.67-6.31c0 8.23-6.83 16.53-22.09 16.53-13.5 0-21.53-5.85-22.61-16.45l-.15-1.1h10.52l.21.84c1.29 6.38 7.37 7.72 12.24 7.72 5.34 0 11-1.72 11-6.54 0-2.44-1.59-4.18-4.73-5.16-1.86-.55-4.15-1.2-6.56-1.87-4.16-1.16-8.47-2.38-11.12-3.29-6.56-2.35-10.33-6.93-10.33-12.56 0-10.43 10.16-15.11 20.22-15.11 13.46 0 20.42 5.07 21.3 15.49l.09 1.07H434.5l-.14-.82c-1-6-7-6.9-10.48-6.9-3 0-10 .53-10 5.5 0 2.25 1.93 3.91 5.89 5.06 1.18.33 2.94.78 5 1.31 4.22 1.09 9.48 2.46 12.13 3.37 6.59 2.32 9.93 6.67 9.93 13m49.39 0c0 8.23-6.83 16.53-22.09 16.53-13.5 0-21.53-5.85-22.61-16.45l-.11-1.09H462l.12.74c1.29 6.38 7.37 7.72 12.24 7.72 5.34 0 11-1.72 11-6.54 0-2.44-1.59-4.18-4.72-5.16-1.86-.55-4.15-1.2-6.57-1.87-4.16-1.16-8.46-2.38-11.11-3.29-6.57-2.35-10.33-6.93-10.33-12.56 0-10.43 10.16-15.11 20.22-15.11 13.46 0 20.42 5.07 21.29 15.49l.09 1.07H483.9l-.14-.82c-1-6-7-6.9-10.48-6.9-3 0-9.95.53-9.95 5.5 0 2.25 1.93 3.91 5.89 5.06 1.18.33 2.94.78 5 1.31 4.22 1.09 9.48 2.46 12.13 3.37 6.58 2.32 9.93 6.67 9.93 13m8.43-30.78a7.37 7.37 0 1 1 7.29-7.37 7.23 7.23 0 0 1-7.29 7.37m0-13.49a6.12 6.12 0 1 0 6 6.12 5.91 5.91 0 0 0-6-6.12m-.85 7.49v2.46h-2.17v-7.74h3.62a2.58 2.58 0 0 1 2.86 2.7 2.26 2.26 0 0 1-1.49 2.34l1.77 2.7H506l-1.49-2.46h-.68zm1.21-3.49h-1.21v1.73h1.21a.86.86 0 0 0 1-.85.88.88 0 0 0-1-.89"></path>
            </svg>
        </a>
    </figure>
</aside>
<header id="page-header">
    <div class="toggle-nav"><span class="k-icon k-i-menu"></span></div>


    <div id="logo-bar">
        <a href="/introduction">
            <img alt="Kendo UI logo" class="logo" src="/images/kendo-ui.svg">
        </a>
    </div>

    
    <span class="show-search">
        <span class="k-icon k-i-search"></span>
    </span>
    
    <div class="nav-buttons">
        <a href="http://demos.telerik.com/kendo-ui/" class="btn demos-btn">Demos</a>
        <a href="http://www.telerik.com/kendo-ui" class="btn about-btn">About</a>
        <a href="http://www.telerik.com/purchase/kendo-ui" class="btn pricing-btn">Pricing</a>
        <a href="http://www.telerik.com/download/kendo-ui" class="btn btn-primary">Try now</a>
    </div>
</header>
        <div id="page-inner-content">
    <div id="page-nav">
        <div id="page-tree"></div>
        <script>
        $("#page-tree").kendoTreeView({
            dataSource: {
                transport: {
                    read: {
                        url: "/default.json",
                        dataType: "json"
                    }
                },
                schema: {
                    model: {
                        id: "path",
                        children: "items",
                        hasChildren: "items"
                    }
                }
            },
            messages: {
                loading: " "
            },
            select: preventParentSelection,
            template: navigationTemplate("/"),
            dataBound: expandNavigation("api/javascript/data/schedulerevent.html")
        });
        </script>
    </div>

    <a id="page-edit-link" href="https://github.com/telerik/kendo-ui-core/edit/master/docs//api/javascript/data/schedulerevent.md"><span class="k-icon k-i-pencil"></span> Edit this page</a>
    <div id="markdown-toc"></div>

    <div id="page-article">
        <article>
            
             <h1 id="kendodataschedulerevent"><a href="#kendodataschedulerevent">kendo.data.SchedulerEvent</a></h1>

<p>The <code>kendo.data.SchedulerEvent</code> class represents a data item from the <a href="/api/framework/schedulerdatasource">kendo.data.SchedulerDataSource</a>. Inherits from <a href="/api/framework/model">kendo.data.Model</a>.</p>

<h2 id="configuration"><a href="#configuration">Configuration</a></h2>

<h3 id="configuration-description">
<a href="#configuration-description">description </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a> <em>(default: "")</em>
</h3>

<p>The optional event description.</p>

<h4>Example - set the description of an event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00"),
    description: "Lunch with Harry and Steve"
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-end">
<a href="#configuration-end">end </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" class="type-link"><code>Date</code></a>
</h3>

<p>The date at which the scheduler event ends. The <code>end</code> date is mandatory.</p>

<h4>Example - set the end date of an event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-endTimezone">
<a href="#configuration-endTimezone">endTimezone </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a> <em>(default: undefined)</em>
</h3>

<p>The timezone of the <code>end</code> date. If not specified the <a href="/api/javascript/ui/scheduler#configuration-timezone">timezone</a> will be used.</p>

<p>The complete list of the supported timezones is available in the <a href="http://en.wikipedia.org/wiki/List_of_IANA_time_zones">List of IANA time zones</a> Wikipedia page.</p>

<h4>Example - set the end timezone of an event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00"),
    endTimezone: "Europe/Sofia"
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-id">
<a href="#configuration-id">id </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="type-link"><code>Number |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h3>

<p>The mandatory unique identifier of the event.</p>

<h4>Example - set the identifier of an event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-isAllDay">
<a href="#configuration-isAllDay">isAllDay </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a> <em>(default: false)</em>
</h3>

<p>If set to <code>true</code> the event is "all day". By default events are not all day.</p>

<blockquote>
<p><strong>Important</strong>: When <code>isAllDay</code> is set to <code>true</code> the <code>start</code> and <code>end</code> fields must be set to the same date.</p>
</blockquote>

<h4>Example - create all day event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Birthday",
    start: new Date("2013/4/4 00:00"),
    end: new Date("2013/4/4 00:00"),
    isAllDay: true
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-recurrenceException">
<a href="#configuration-recurrenceException">recurrenceException </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a> <em>(default: undefined)</em>
</h3>

<p>The recurrence exceptions. A list of comma separated dates formatted using the <code>yyyyMMddTHHmmssZ</code> format string.</p>

<blockquote>
<p><strong>Important</strong>: The dates should be encoded in UTC.</p>
</blockquote>

<h4>Example - set recurrence exceptions</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    start: new Date("2013/9/2 12:00"),
    end: new Date("2013/9/2 12:30"),
    title: "Lunch",
    recurrenceRule: "FREQ=DAILY",
    recurrenceException: new Date("2013/9/3 12:00").toISOString()
});
var exception =  new kendo.data.SchedulerEvent({
    id: 2,
    start: new Date("2013/9/3 12:30"),
    end: new Date("2013/9/3 13:00"),
    title: "Lunch",
    recurrenceId: 1
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-recurrenceId">
<a href="#configuration-recurrenceId">recurrenceId </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="type-link"><code>Number |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a> <em>(default: undefined)</em>
</h3>

<p>The <code>id</code> of the recurrence parent event. Required for events that are recurrence exceptions.</p>

<h4>Example - set recurrence exceptions</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    start: new Date("2013/9/2 12:00"),
    end: new Date("2013/9/2 12:30"),
    title: "Lunch",
    recurrenceRule: "FREQ=DAILY",
    recurrenceException: new Date("2013/9/3 12:00").toISOString()
});
var exception =  new kendo.data.SchedulerEvent({
    id: 2,
    start: new Date("2013/9/3 12:30"),
    end: new Date("2013/9/3 13:00"),
    title: "Lunch",
    recurrenceId: 1
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-recurrenceRule">
<a href="#configuration-recurrenceRule">recurrenceRule </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a> <em>(default: undefined)</em>
</h3>

<p>The recurrence rule describing the recurring pattern of the event. The format follows the <a href="http://tools.ietf.org/html/rfc5545">iCal specification</a>.</p>

<h4>Example - set the recurrence rule</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    start: new Date("2013/9/2 12:00"),
    end: new Date("2013/9/2 12:30"),
    title: "Lunch",
    recurrenceRule: "FREQ=DAILY"
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-start">
<a href="#configuration-start">start </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" class="type-link"><code>Date</code></a>
</h3>

<p>The date at which the scheduler event starts. The <code>start</code> date is mandatory.</p>

<h4>Example - set the start date of an event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-startTimezone">
<a href="#configuration-startTimezone">startTimezone </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a> <em>(default: undefined)</em>
</h3>

<p>The timezone of the <code>start</code> date. If not specified the <a href="/api/javascript/ui/scheduler#configuration-timezone">timezone</a> will be used.</p>

<p>The complete list of the supported timezones is available in the <a href="http://en.wikipedia.org/wiki/List_of_IANA_time_zones">List of IANA time zones</a> Wikipedia page.</p>

<h4>Example - set the end timezone of an event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    startTimezone: "Europe/Sofia",
    end: new Date("2013/4/4 13:00")
});
&lt;/script&gt;
</code></pre>

<h3 id="configuration-title">
<a href="#configuration-title">title </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a> <em>(default: "")</em>
</h3>

<p>The title of the event which is displayed by the scheduler widget.</p>

<h4>Example - set the title of an event</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
&lt;/script&gt;
</code></pre>

<h2 id="fields"><a href="#fields">Fields</a></h2>

<h3 id="fields-description">
<a href="#fields-description">description </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h3>

<p>The optional event description.</p>

<h4>Example - get the event description</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00"),
    description: "Lunch with Harry and Steve"
});
console.log(event.description); // outputs "Lunch with Harry and Steve"
&lt;/script&gt;
</code></pre>

<h3 id="fields-end">
<a href="#fields-end">end </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" class="type-link"><code>Date</code></a>
</h3>

<p>The date at which the scheduler event ends.</p>

<h4>Example - get the event end date</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
console.log(event.end); // outputs the end date
&lt;/script&gt;
</code></pre>

<h3 id="fields-endTimezone">
<a href="#fields-endTimezone">endTimezone </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h3>

<p>The timezone of the <code>end</code> date.</p>

<h4>Example - get the event end timezone</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00"),
    endTimezone: "Europe/Sofia"
});
console.log(event.endTimezone); // outputs "Europe/Sofia"
&lt;/script&gt;
</code></pre>

<h3 id="fields-id">
<a href="#fields-id">id </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="type-link"><code>Number |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h3>

<p>The unique identifier of the event.</p>

<h4>Example - get the event id</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
console.log(event.id); // outputs "1"
&lt;/script&gt;
</code></pre>

<h3 id="fields-isAllDay">
<a href="#fields-isAllDay">isAllDay </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a>
</h3>

<p>If set to <code>true</code> the event is "all day".</p>

<h4>Example - get the event isAllDay field</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Birthday",
    start: new Date("2013/4/4 00:00"),
    end: new Date("2013/4/4 00:00"),
    isAllDay: true
});
console.log(event.isAllDay); // outputs "true"
&lt;/script&gt;
</code></pre>

<h3 id="fields-recurrenceException">
<a href="#fields-recurrenceException">recurrenceException </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h3>

<p>The recurrence exceptions. A list of comma separated dates formatted using the <code>yyyyMMddTHHmmssZ</code> format string.</p>

<h4>Example - get the event recurrence exception field</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    start: new Date("2013/9/2 12:00"),
    end: new Date("2013/9/2 12:30"),
    title: "Lunch",
    recurrenceRule: "FREQ=DAILY",
    recurrenceException: new Date("2013/9/3 12:00").toISOString()
});
console.log(event.recurrenceException); // outputs the recurrence exception
&lt;/script&gt;
</code></pre>

<h3 id="fields-recurrenceId">
<a href="#fields-recurrenceId">recurrenceId </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="type-link"><code>Number |</code></a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h3>

<p>The <code>id</code> of the recurrence parent event.</p>

<h4>Example - get the event recurrence parent id</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    start: new Date("2013/9/2 12:00"),
    end: new Date("2013/9/2 12:30"),
    title: "Lunch",
    recurrenceRule: "FREQ=DAILY",
    recurrenceException: new Date("2013/9/3 12:00").toISOString()
});
var exception =  new kendo.data.SchedulerEvent({
    id: 2,
    start: new Date("2013/9/3 12:30"),
    end: new Date("2013/9/3 13:00"),
    title: "Lunch",
    recurrenceId: 1
});
console.log(exception.recurrenceId); // outputs "1"
&lt;/script&gt;
</code></pre>

<h3 id="fields-recurrenceRule">
<a href="#fields-recurrenceRule">recurrenceRule </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h3>

<p>The recurrence rule describing the recurring pattern of the event.</p>

<h4>Example - get the event recurrence rule</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    start: new Date("2013/9/2 12:00"),
    end: new Date("2013/9/2 12:30"),
    title: "Lunch",
    recurrenceRule: "FREQ=DAILY"
});
console.log(event.recurrenceRule); // outputs "FREQ=DAILY"
&lt;/script&gt;
</code></pre>

<h3 id="fields-start">
<a href="#fields-start">start </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" class="type-link"><code>Date</code></a>
</h3>

<p>The date at which the scheduler event starts.</p>

<h4>Example - get the event start date</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
console.log(event.start); // outputs the end date
&lt;/script&gt;
</code></pre>

<h3 id="fields-startTimezone">
<a href="#fields-startTimezone">startTimezone </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h3>

<p>The timezone of the <code>start</code> date.</p>

<h4>Example - get the event start timezone</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    startTimezone: "Europe/Sofia",
    end: new Date("2013/4/4 13:00")
});
console.log(event.startTimezone); // outputs "Europe/Sofia"
&lt;/script&gt;
</code></pre>

<h3 id="fields-title">
<a href="#fields-title">title </a><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h3>

<p>The title of the event which is displayed by the scheduler widget.</p>

<h4>Example - get the event title</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00")
});
console.log(event.title); // outputs "Lunch"
&lt;/script&gt;
</code></pre>

<h2 id="methods"><a href="#methods">Methods</a></h2>

<p>See the <a href="/api/framework/model#methods">Model methods</a> for all inherited methods.</p>

<h3 id="methods-SchedulerEvent.define"><a href="#methods-SchedulerEvent.define">SchedulerEvent.define</a></h3>

<p>Defines a new <code>SchedulerEvent</code> type using the provided options.</p>

<h4>Parameters</h4>

<h5>options <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h5>

<p>Describes the configuration options of the new scheduler event class.</p>

<h5>options.id <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h5>

<p>The name of the field which acts as an identifier of the scheduler event.
The identifier is used to determine if a model instance is new or existing one.
If the value of the field specified is equal to the default value (specified through the <code>fields</code> configuration) the model is considered as new.</p>

<h5>options.fields <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h5>

<p>A set of key/value pairs the configure the model fields. The key specifies the name of the field.
Quote the key if it contains spaces or other symbols which are not valid for a JavaScript identifier.</p>

<h5>options.fields.fieldName.defaultValue</h5>

<p>Specifies the which will be used for the field when a new model instance is created. Default settings depend on the type of the field. Default for "string" is <code>""</code>,
for "number" is <code>0</code> and for "date" is <code>new Date()</code> (today).</p>

<h5>options.fields.fieldName.editable <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a>
</h5>

<p>Specifies if the field is editable or not. The default value is <code>true</code>.</p>

<h5>options.fields.fieldName.nullable <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a>
</h5>

<p>Specifies if the <code>defaultValue</code> setting should be used. The default is <code>false</code>.</p>

<h5>options.fields.fieldName.parse <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type-link"><code>Function</code></a>
</h5>

<p>Specifies the function which will parse the field value. If not set default parsers will be used.</p>

<h5>options.fields.fieldName.type <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h5>

<p>Specifies the the type of the field. The available options are <code>"string"</code>, <code>"number"</code>, <code>"boolean"</code>, <code>"date</code>". The default is <code>"string"</code>.</p>

<h5>options.fields.fieldName.validation <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h5>

<p>Specifies the validation options which will be used by <a href="/api/framework/validator">Kendo Validator</a>.</p>

<h4>Example - define custom scheduler event</h4>

<pre><code>var Task = kendo.data.SchedulerEvent.define({
    id: "taskId",
    fields: {
        taskId: { from: "TaskID", type: "number" },
        title: { from: "Title", defaultValue: "No title", validation: { required: true } },
        start: { type: "date", from: "Start" },
        end: { type: "date", from: "End" },
        startTimezone: { from: "StartTimezone" },
        endTimezone: { from: "EndTimezone" },
        description: { from: "Description" },
        recurrenceId: { from: "RecurrenceID" },
        recurrenceRule: { from: "RecurrenceRule" },
        recurrenceException: { from: "RecurrenceException" },
        ownerId: { from: "OwnerID", defaultValue: 1 },
        isAllDay: { type: "boolean", from: "IsAllDay" }
    }
});
</code></pre>

<h3 id="methods-clone"><a href="#methods-clone">clone</a></h3>

<p>Clones the scheduler event.</p>

<h4>Parameters</h4>

<h5>options <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h5>

<p>Additional options passed to the SchedulerEvent constructor.</p>

<h5>updateUid <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a><em>(default: false)</em>
</h5>

<p>If you pass <code>true</code> the <code>uid</code> of the event will be <strong>updated</strong>.</p>

<h4>Returns</h4>

<p><code>kendo.data.SchedulerEvent</code> the cloned scheduler event.</p>

<h4>Example - clone the scheduler event</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date(2013, 10, 11, 12),
        end: new Date(2013, 10, 11, 14)
    });

    var clone = event.clone();
&lt;/script&gt;
</code></pre>

<h4>Example - override start and end dates of the event</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date("2013/4/4 12:00"),
        end: new Date("2013/4/4 14:00")
    });

    var clone = event.clone({
        start: new Date("2013/4/4 2:00"),
        end: new Date("2013/4/4 4:00")
    });
&lt;/script&gt;
</code></pre>

<h3 id="methods-duration"><a href="#methods-duration">duration</a></h3>

<p>Returns the scheduler event length in milliseconds.</p>

<h4>Returns</h4>

<p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="type-link"><code>Number</code></a> the length of the event.</p>

<h4>Example - get length of the event</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date("2013/4/4 12:00"),
        end: new Date("2013/4/4 14:00")
    });

    console.log(event.duration());
&lt;/script&gt;
</code></pre>

<h3 id="methods-expand"><a href="#methods-expand">expand</a></h3>

<p>Expands the event for a specific period based on the <code>recurrenceRule</code> option.</p>

<h4>Parameters</h4>

<h5>start <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" class="type-link"><code>Date</code></a>
</h5>

<p>The start date of the occurrence period.</p>

<h5>end <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" class="type-link"><code>Date</code></a>
</h5>

<p>The end date of the occurrence period.</p>

<h5>timeZoneId <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="type-link"><code>String</code></a>
</h5>

<p>The time zone ID used to convert the recurrence rule dates.</p>

<h4>Returns</h4>

<p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="type-link"><code>Array</code></a> list of occurrences.</p>

<h4>Example - get the occurrences</h4>

<pre><code>&lt;script&gt;
var event = new kendo.data.SchedulerEvent({
    id: 1,
    title: "Lunch",
    start: new Date("2013/4/4 12:00"),
    end: new Date("2013/4/4 13:00"),
    recurrenceRule: "FREQ=DAILY"
});

var occurrences = event.expand(new Date("2013/4/4"), new Date("2013/5/4"), "Etc/UTC");
&lt;/script&gt;
</code></pre>

<h3 id="methods-update"><a href="#methods-update">update</a></h3>

<p>Updates the scheduler event.</p>

<h4>Parameters</h4>

<h5>eventInfo <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h5>

<p>The new values, which will be used to update the event.</p>

<h4>Example - update the scheduler event</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date("2013/4/4 12:00"),
        end: new Date("2013/4/4 14:00")
    });

    event.update({
        start: new Date("2013/4/4 2:00"),
        end: new Date("2013/4/4 4:00")
    });
&lt;/script&gt;
</code></pre>

<h3 id="methods-isMultiDay"><a href="#methods-isMultiDay">isMultiDay</a></h3>

<p>Checks whether the event is equal to or longer then twenty four hours.</p>

<h4>Returns</h4>

<p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a> return <code>true</code> if event is equal to or longer then 24 hours.</p>

<h4>Example - check whether an event is a multi-day event</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date("2013/4/4"),
        end: new Date("2013/4/7")
    });

    console.log(event.isMultiDay()); //logs 'true'
&lt;/script&gt;
</code></pre>

<h3 id="methods-isException"><a href="#methods-isException">isException</a></h3>

<p>Checks whether the event is a recurrence exception.</p>

<h4>Returns</h4>

<p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a> return <code>true</code> if event is a recurrence exception.</p>

<h4>Example - check whether an event is an exception</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 2,
        recurrenceId: 1, //id of the recurrence head event
        title: "Task1",
        start: new Date("2013/4/4"),
        end: new Date("2013/4/4")
    });

    console.log(event.isException()); //logs 'true'
&lt;/script&gt;
</code></pre>

<h3 id="methods-isOccurrence"><a href="#methods-isOccurrence">isOccurrence</a></h3>

<p>Checks whether the event is an occurrence part of a recurring series.</p>

<h4>Returns</h4>

<p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a> return <code>true</code> if event is an occurrence.</p>

<h4>Example - check whether an event is an occurrence</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 0, //event has a default id
        recurrenceId: 1, //id of the recurrence head event
        title: "Task1",
        start: new Date("2013/4/4"),
        end: new Date("2013/4/4")
    });

    console.log(event.isOccurrence()); //logs 'true'
&lt;/script&gt;
</code></pre>

<h3 id="methods-isRecurring"><a href="#methods-isRecurring">isRecurring</a></h3>

<p>Checks whether the event is part of a recurring series.</p>

<h4>Returns</h4>

<p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a> return <code>true</code> if event is recurring.</p>

<h4>Example - check whether an event is an occurrence</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 0,
        recurrenceId: 1, //id of the recurrence head event
        title: "Task1",
        start: new Date("2013/4/4"),
        end: new Date("2013/4/4")
    });

    var event2 = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date("2013/4/4"),
        end: new Date("2013/4/4"),
        recurrenceRule: "FREQ=DAILY"
    });

    console.log(event.isRecurring()); //logs 'true'
    console.log(event2.isRecurring()); //logs 'true'
&lt;/script&gt;
</code></pre>

<h3 id="methods-isRecurrenceHead"><a href="#methods-isRecurrenceHead">isRecurrenceHead</a></h3>

<p>Checks whether the event is the head of a recurring series.</p>

<h4>Returns</h4>

<p><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="type-link"><code>Boolean</code></a> return <code>true</code> if event is a recurrence head.</p>

<h4>Example - check whether an event is a recurrence head</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date("2013/4/4"),
        end: new Date("2013/4/4"),
        recurrenceRule: "FREQ=DAILY"
    });

    console.log(event.isRecurrenceHead()); //logs 'true'
&lt;/script&gt;
</code></pre>

<h3 id="methods-toOccurrence"><a href="#methods-toOccurrence">toOccurrence</a></h3>

<p>Converts the scheduler event to a event occurrence. Method will remove <code>recurrenceRule</code>, <code>recurrenceException</code> options, will add a <code>recurrenceId</code> field and will set <code>id</code> to the default one.</p>

<h4>Parameters</h4>

<h5>options <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type-link"><code>Object</code></a>
</h5>

<p>Additional options passed to the SchedulerEvent constructor.</p>

<blockquote>
<p><code>uid</code> property of the event will be preserved.</p>
</blockquote>

<h4>Returns</h4>

<p><code>kendo.data.SchedulerEvent</code> the occurrence.</p>

<h4>Example - create occurrence from a scheduler event</h4>

<pre><code>&lt;script&gt;
    var event = new kendo.data.SchedulerEvent({
        id: 1,
        title: "Task1",
        start: new Date(2013, 10, 11, 12),
        end: new Date(2013, 10, 11, 14),
        recurrenceRule: "FREQ=DAILY"
    });

    var occurrence = event.toOccurrence();

    console.log(occurrence.id); //logs default id
    console.log(occurrence.recurrenceId); //logs id of the head. In this case '1'
    console.log(occurrence.recurrenceRule); //logs 'null'
&lt;/script&gt;
</code></pre>

<h2 id="events"><a href="#events">Events</a></h2>

<p>See the <a href="/api/framework/model#events">Model events</a> for all inherited events.</p> 
        </article>
    </div>
    <div id="feedback-container">
  <div id="feedback-section">
    <script src="/assets/feedback.js?cb=e99a3802c754fe2425831d58312c7c8b"></script>
    <span id="popupNotification"></span>
    <div id="feedback-menu-container">
      <div id="helpful-buttons-container">
        <span class="side-title">Is this article helpful?</span>
        <a class="button" id="yesButton">Yes</a> /
        <a class="button" id="noButton">No</a>
      </div>
      <div id="feedback-submitted-container">
        <span class="side-title">Thank you for your feedback!</span>
      </div>
    </div>
    <div id="feedback-window-container">
      <div id="feedback-form-window" style="background-color: white;">
        <h1 class="feedback-extw__title">Give article feedback</h1>
        <p>Tell us how we can improve this article</p>
        <span id="feedback-form-popup-container"></span>
        <form id="feedback-form">
          <div id="feedback-checkbox-area">
            <input id="hidden-sheet-id" type="hidden" value="14zzclhdh7dMLpg0iq4-2hweCdEiuxxqP3tHdr42-_Cs">
            <label>
              <input type="checkbox" data-bind="checked: outdatedSample" /> Code samples are inaccurate / outdated.
            </label>
            <span class="required-field" data-bind="visible: outdatedSample"></span>
            <textarea id="feedback-code-sample-text-input" placeholder="Please, specify more details ..." class="feedback-extw__textarea"
              data-bind="visible: outdatedSample, value: inaccurateOutdatedCodeSamplesText">
          </textarea>
            <label>
              <input type="checkbox" data-bind="checked: otherMoreInformation" /> I expected to find other / more information.
            </label>
            <span class="required-field" data-bind="visible: otherMoreInformation"></span>
            <textarea id="feedback-more-information-text-input" class="feedback-extw__textarea" placeholder="Please, specify what information can be added ..."
              data-bind="visible: otherMoreInformation, value: otherMoreInformationText">
          </textarea>
            <label>
              <input type="checkbox" data-bind="checked: textErrors" /> There are typos / broken links / broken page elements.
            </label>
            <span class="required-field" data-bind="visible: textErrors"></span>
            <textarea id="feedback-text-errors-text-input" class="feedback-extw__textarea" placeholder="Please, specify what needs to be fixed ..."
              data-bind="visible: textErrors, value: typosLinksElementsText">
          </textarea>
            <label>
              <input type="checkbox" data-bind="checked: inaccurateContent" /> Content is inaccurate / outdated.
            </label>
            <span class="required-field" data-bind="visible: inaccurateContent"></span>
            <textarea id="feedback-inaccurate-content-text-input" class="feedback-extw__textarea" placeholder="Please, specify which conent ..."
              data-bind="visible: inaccurateContent, value: inaccurateOutdatedContentText"></textarea>
            <label>
              <input type="checkbox" data-bind="checked: otherFeedback" /> Other
            </label>
            <span class="required-field" data-bind="visible: otherFeedback"></span>
            <textarea id="feedback-other-text-input" placeholder="Please, enter more details or not listed feedback ..." class="feedback-extw__textarea"
              data-bind="visible: otherFeedback, value: textFeedback">
          </textarea>
            <input id="feedback-email-input" type="email" placeholder="email (optional)" data-email-msg="Email format is not valid."
              class="feedback-extw__input input" data-bind="value: email" />
          </div>
        </form>
        <div class="feedback-extw__foot">
          <button id="form-submit-button" class="feedback-extw__button button button--action">Send feedback</button>
          <button id="form-close-button" class="feedback-extw__button button">Cancel</button>
        </div>
      </div>
    </div>
    <a id="close-button" class="button">
      <img src="/images/close-btn.svg" alt="close" />
    </a>
  </div>
  <div id="feedback-section-dummy">Dummy</div>
</div>
    <footer>
    <p>Copyright &copy; 2017 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.</p>
</footer>

</div>
    </body>
</html>

